Kosher Kotlin - K-droid Fork/io.github.kdroidfilter.kosherkotlin.util

Package-level declarations

Types

An abstract class that all sun time calculating classes extend. This allows the algorithm used to be changed at runtime, easily allowing comparison the results of using different algorithms.

DateUtils

object DateUtils

TODO this is debateably an anti-pattern. Figure out where to put these functinos.

GeoLocation

data class GeoLocation(var timeZone: TimeZone, var locationName: String)

A class that contains location information such as latitude and longitude required for astronomical calculations. The elevation field may not be used by some calculation engines and would be ignored if set. Check the documentation for specific implementations of the AstronomicalCalculator to see if elevation is calculated as part of the algorithm.

Location

data class Location(val latitude: Double, val longitude: Double, val elevation: Double? = null, val accuracy: Double? = null, val timestamp: Long? = null, val tz: TimeZone? = null, val locationName: String? = null)

Represents a coordinate on the globe. In contrast to GeoLocation which has an associated timezone and place name, Location may not. This is to accommodate various platforms, which may not expose as rich information as GeoLocation requires.

NOAACalculator

class NOAACalculator : AstronomicalCalculator

Implementation of sunrise and sunset methods to calculate astronomical times based on the NOAA algorithm. This calculator uses the Java algorithm based on the implementation by NOAA - National Oceanic and Atmospheric Administration's Surface Radiation Research Branch. NOAA's implementation is based on equations from Astronomical Algorithms by Jean Meeus. Added to the algorithm is an adjustment of the zenith to account for elevation. The algorithm can be found in the Wikipedia Sunrise Equation article.

SunTimesCalculator

class SunTimesCalculator : AstronomicalCalculator

Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm written by [Kevin

Time

data class Time(var hours: Int = 0, var minutes: Int = 0, var seconds: Int = 0, var milliseconds: Int = 0, var isNegative: Boolean = false)

A class that represents a numeric time. Times that represent a time of day are stored as java.util.Dates in this API. The time class is used to represent numeric time such as the time in hours, minutes, seconds and milliseconds of a com.kosherjava.zmanim.AstronomicalCalendar.temporalHour.

WeekFormat

object WeekFormat